<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NumCpp: nc::utils Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NumCppLogoDoxygen.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">NumCpp
   &#160;<span id="projectnumber">2.4.0</span>
   </div>
   <div id="projectbrief">A Templatized Header Only C++ Implementation of the Python NumPy Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('namespacenc_1_1utils.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">nc::utils Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a46e88717d4d32003bb449fd5cefd401c"><td class="memTemplParams" colspan="2">template&lt;typename dtype &gt; </td></tr>
<tr class="memitem:a46e88717d4d32003bb449fd5cefd401c"><td class="memTemplItemLeft" align="right" valign="top">constexpr dtype&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a46e88717d4d32003bb449fd5cefd401c">cube</a> (dtype inValue) noexcept</td></tr>
<tr class="separator:a46e88717d4d32003bb449fd5cefd401c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a139da62fc9c51ae191e7451bb4edb706"><td class="memTemplParams" colspan="2">template&lt;typename dtype , enable_if_t&lt; std::is_integral&lt; dtype &gt;::value, int &gt;  = 0&gt; </td></tr>
<tr class="memitem:a139da62fc9c51ae191e7451bb4edb706"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a139da62fc9c51ae191e7451bb4edb706">essentiallyEqual</a> (const std::complex&lt; dtype &gt; &amp;inValue1, const std::complex&lt; dtype &gt; &amp;inValue2) noexcept</td></tr>
<tr class="separator:a139da62fc9c51ae191e7451bb4edb706"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e935ef90aaa774b37e6ab4b5316e01f"><td class="memTemplParams" colspan="2">template&lt;typename dtype , enable_if_t&lt; std::is_floating_point&lt; dtype &gt;::value, int &gt;  = 0&gt; </td></tr>
<tr class="memitem:a7e935ef90aaa774b37e6ab4b5316e01f"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a7e935ef90aaa774b37e6ab4b5316e01f">essentiallyEqual</a> (const std::complex&lt; dtype &gt; &amp;inValue1, const std::complex&lt; dtype &gt; &amp;inValue2, const std::complex&lt; dtype &gt; &amp;inEpsilon) noexcept</td></tr>
<tr class="separator:a7e935ef90aaa774b37e6ab4b5316e01f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a963b90e7c9a3b057a924298750ddf74c"><td class="memTemplParams" colspan="2">template&lt;typename dtype , enable_if_t&lt; std::is_integral&lt; dtype &gt;::value, int &gt;  = 0&gt; </td></tr>
<tr class="memitem:a963b90e7c9a3b057a924298750ddf74c"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a963b90e7c9a3b057a924298750ddf74c">essentiallyEqual</a> (dtype inValue1, dtype inValue2) noexcept</td></tr>
<tr class="separator:a963b90e7c9a3b057a924298750ddf74c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedd8afd691cf9f5a8f8e12c9ca33743a"><td class="memTemplParams" colspan="2">template&lt;typename dtype , enable_if_t&lt; std::is_floating_point&lt; dtype &gt;::value, int &gt;  = 0&gt; </td></tr>
<tr class="memitem:aedd8afd691cf9f5a8f8e12c9ca33743a"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#aedd8afd691cf9f5a8f8e12c9ca33743a">essentiallyEqual</a> (dtype inValue1, dtype inValue2, dtype inEpsilon) noexcept</td></tr>
<tr class="separator:aedd8afd691cf9f5a8f8e12c9ca33743a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5016e06ac7ca186ff6c110b314d30209"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a5016e06ac7ca186ff6c110b314d30209">gaussian</a> (double inX, double inY, double inSigma) noexcept</td></tr>
<tr class="separator:a5016e06ac7ca186ff6c110b314d30209"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a263704ee2cc6ab3f77b462522c7150f8"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a263704ee2cc6ab3f77b462522c7150f8">gaussian1d</a> (double inX, double inMu, double inSigma) noexcept</td></tr>
<tr class="separator:a263704ee2cc6ab3f77b462522c7150f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a691a52cfcc401340af355bd53869600e"><td class="memItemLeft" align="right" valign="top">constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e">interp</a> (double inValue1, double inValue2, double inPercent) noexcept</td></tr>
<tr class="separator:a691a52cfcc401340af355bd53869600e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16a6ad93c420ed7a003d9921bee1a7c6"><td class="memTemplParams" colspan="2">template&lt;typename dtype &gt; </td></tr>
<tr class="memitem:a16a6ad93c420ed7a003d9921bee1a7c6"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a16a6ad93c420ed7a003d9921bee1a7c6">num2str</a> (dtype inNumber)</td></tr>
<tr class="separator:a16a6ad93c420ed7a003d9921bee1a7c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a716a63ef8627c73f6cc4146481fcabdf"><td class="memTemplParams" colspan="2">template&lt;typename dtype &gt; </td></tr>
<tr class="memitem:a716a63ef8627c73f6cc4146481fcabdf"><td class="memTemplItemLeft" align="right" valign="top">dtype&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a716a63ef8627c73f6cc4146481fcabdf">power</a> (dtype inValue, <a class="el" href="namespacenc.html#a9ba5a0aa26753a185985b8273fb9062d">uint8</a> inPower) noexcept</td></tr>
<tr class="separator:a716a63ef8627c73f6cc4146481fcabdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac113b30b96f9c707c0cbe2eecbabe85f"><td class="memTemplParams" colspan="2">template&lt;typename dtype1 , typename dtype2 &gt; </td></tr>
<tr class="memitem:ac113b30b96f9c707c0cbe2eecbabe85f"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#ac113b30b96f9c707c0cbe2eecbabe85f">powerf</a> (dtype1 inValue, const dtype2 inPower) noexcept</td></tr>
<tr class="separator:ac113b30b96f9c707c0cbe2eecbabe85f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae792e10a24b7e5b8291a6c31a28a4512"><td class="memTemplParams" colspan="2">template&lt;typename dtype &gt; </td></tr>
<tr class="memitem:ae792e10a24b7e5b8291a6c31a28a4512"><td class="memTemplItemLeft" align="right" valign="top">constexpr dtype&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#ae792e10a24b7e5b8291a6c31a28a4512">sqr</a> (dtype inValue) noexcept</td></tr>
<tr class="separator:ae792e10a24b7e5b8291a6c31a28a4512"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83530b13c9cc3b01b9bd8b8d3113290a"><td class="memTemplParams" colspan="2">template&lt;typename dtype &gt; </td></tr>
<tr class="memitem:a83530b13c9cc3b01b9bd8b8d3113290a"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacenc_1_1utils.html#a83530b13c9cc3b01b9bd8b8d3113290a">value2str</a> (dtype inValue)</td></tr>
<tr class="separator:a83530b13c9cc3b01b9bd8b8d3113290a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a46e88717d4d32003bb449fd5cefd401c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46e88717d4d32003bb449fd5cefd401c">&#9670;&nbsp;</a></span>cube()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr dtype nc::utils::cube </td>
          <td>(</td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Cubes in input value</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>cubed value </dd></dl>

</div>
</div>
<a id="a139da62fc9c51ae191e7451bb4edb706"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a139da62fc9c51ae191e7451bb4edb706">&#9670;&nbsp;</a></span>essentiallyEqual() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype , enable_if_t&lt; std::is_integral&lt; dtype &gt;::value, int &gt;  = 0&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool nc::utils::essentiallyEqual </td>
          <td>(</td>
          <td class="paramtype">const std::complex&lt; dtype &gt; &amp;&#160;</td>
          <td class="paramname"><em>inValue1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::complex&lt; dtype &gt; &amp;&#160;</td>
          <td class="paramname"><em>inValue2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>tests that 2 floating point values are "essentially equal"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue1</td><td></td></tr>
    <tr><td class="paramname">inValue2</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>

</div>
</div>
<a id="a7e935ef90aaa774b37e6ab4b5316e01f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e935ef90aaa774b37e6ab4b5316e01f">&#9670;&nbsp;</a></span>essentiallyEqual() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype , enable_if_t&lt; std::is_floating_point&lt; dtype &gt;::value, int &gt;  = 0&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool nc::utils::essentiallyEqual </td>
          <td>(</td>
          <td class="paramtype">const std::complex&lt; dtype &gt; &amp;&#160;</td>
          <td class="paramname"><em>inValue1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::complex&lt; dtype &gt; &amp;&#160;</td>
          <td class="paramname"><em>inValue2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::complex&lt; dtype &gt; &amp;&#160;</td>
          <td class="paramname"><em>inEpsilon</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>tests that 2 floating point values are "essentially equal"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue1</td><td></td></tr>
    <tr><td class="paramname">inValue2</td><td></td></tr>
    <tr><td class="paramname">inEpsilon</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>

</div>
</div>
<a id="a963b90e7c9a3b057a924298750ddf74c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a963b90e7c9a3b057a924298750ddf74c">&#9670;&nbsp;</a></span>essentiallyEqual() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype , enable_if_t&lt; std::is_integral&lt; dtype &gt;::value, int &gt;  = 0&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool nc::utils::essentiallyEqual </td>
          <td>(</td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>tests that 2 floating point values are "essentially equal"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue1</td><td></td></tr>
    <tr><td class="paramname">inValue2</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>

</div>
</div>
<a id="aedd8afd691cf9f5a8f8e12c9ca33743a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedd8afd691cf9f5a8f8e12c9ca33743a">&#9670;&nbsp;</a></span>essentiallyEqual() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype , enable_if_t&lt; std::is_floating_point&lt; dtype &gt;::value, int &gt;  = 0&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool nc::utils::essentiallyEqual </td>
          <td>(</td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inEpsilon</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>tests that 2 floating point values are "essentially equal"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue1</td><td></td></tr>
    <tr><td class="paramname">inValue2</td><td></td></tr>
    <tr><td class="paramname">inEpsilon</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>

</div>
</div>
<a id="a5016e06ac7ca186ff6c110b314d30209"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5016e06ac7ca186ff6c110b314d30209">&#9670;&nbsp;</a></span>gaussian()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double nc::utils::gaussian </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inY</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inSigma</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>samples a 2D gaussian of mean zero and input STD sigma</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inX</td><td></td></tr>
    <tr><td class="paramname">inY</td><td></td></tr>
    <tr><td class="paramname">inSigma</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>dtype </dd></dl>

</div>
</div>
<a id="a263704ee2cc6ab3f77b462522c7150f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a263704ee2cc6ab3f77b462522c7150f8">&#9670;&nbsp;</a></span>gaussian1d()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double nc::utils::gaussian1d </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inMu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inSigma</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>samples a 1D gaussian of input mean and sigma</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inX</td><td></td></tr>
    <tr><td class="paramname">inMu</td><td></td></tr>
    <tr><td class="paramname">inSigma</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>dtype </dd></dl>

</div>
</div>
<a id="a691a52cfcc401340af355bd53869600e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a691a52cfcc401340af355bd53869600e">&#9670;&nbsp;</a></span>interp()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr double nc::utils::interp </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inValue1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inValue2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>inPercent</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns the linear interpolation between two points</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue1</td><td></td></tr>
    <tr><td class="paramname">inValue2</td><td></td></tr>
    <tr><td class="paramname">inPercent</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>linear interpolated point </dd></dl>

</div>
</div>
<a id="a16a6ad93c420ed7a003d9921bee1a7c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16a6ad93c420ed7a003d9921bee1a7c6">&#9670;&nbsp;</a></span>num2str()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">std::string nc::utils::num2str </td>
          <td>(</td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inNumber</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Converts the number into a string</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inNumber</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::string </dd></dl>

</div>
</div>
<a id="a716a63ef8627c73f6cc4146481fcabdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a716a63ef8627c73f6cc4146481fcabdf">&#9670;&nbsp;</a></span>power()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">dtype nc::utils::power </td>
          <td>(</td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespacenc.html#a9ba5a0aa26753a185985b8273fb9062d">uint8</a>&#160;</td>
          <td class="paramname"><em>inPower</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Raises the input value to an integer power</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue</td><td></td></tr>
    <tr><td class="paramname">inPower</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>inValue raised to inPower </dd></dl>

</div>
</div>
<a id="ac113b30b96f9c707c0cbe2eecbabe85f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac113b30b96f9c707c0cbe2eecbabe85f">&#9670;&nbsp;</a></span>powerf()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype1 , typename dtype2 &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">auto nc::utils::powerf </td>
          <td>(</td>
          <td class="paramtype">dtype1&#160;</td>
          <td class="paramname"><em>inValue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const dtype2&#160;</td>
          <td class="paramname"><em>inPower</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Raises the input value to a floating point power</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue</td><td></td></tr>
    <tr><td class="paramname">inPower</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>inValue raised to inPower </dd></dl>

</div>
</div>
<a id="ae792e10a24b7e5b8291a6c31a28a4512"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae792e10a24b7e5b8291a6c31a28a4512">&#9670;&nbsp;</a></span>sqr()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr dtype nc::utils::sqr </td>
          <td>(</td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Squares in input value</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>squared value </dd></dl>

</div>
</div>
<a id="a83530b13c9cc3b01b9bd8b8d3113290a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83530b13c9cc3b01b9bd8b8d3113290a">&#9670;&nbsp;</a></span>value2str()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename dtype &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">std::string nc::utils::value2str </td>
          <td>(</td>
          <td class="paramtype">dtype&#160;</td>
          <td class="paramname"><em>inValue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Converts the value into a string</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inValue</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::string </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacenc.html">nc</a></li><li class="navelem"><a class="el" href="namespacenc_1_1utils.html">utils</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
